home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / BOI200P.ZIP / INSTALL.BOI < prev    next >
Text File  |  1992-12-14  |  18KB  |  471 lines
  1. This document is effective 12/15/92
  2. INSTALL - BOI 2.00
  3.  
  4.  
  5.     BBS Onliner Interface
  6.     Copyright (C) 1990,1992 Andrew J. Mead
  7.     All Rights Reserved.
  8.  
  9. Introduction
  10.  
  11.     This document is a basic installation guide to doors written with
  12.     the BBS Onliner Interface.  A basic synopsis of the command line
  13.     arguments is given (please see COMMANDS.BOI), and examples (if
  14.     available) of installations under various BBS software are also
  15.     given.  You should also read any door specific documentation as
  16.     well since this only covers the options of the BOI.
  17.  
  18.       Sections
  19.  
  20.       Command Line Directives
  21.         Again Play                  /A
  22.         Player Name                 /N
  23.         Quiet Local Console         /Q
  24.         Limit Hall Of Fame          /X
  25.         Redirect Hall Of Fame       /Y
  26.         Maximum Time Limit          /Z
  27.         Communications Directives
  28.           Locked Com Port           /B
  29.  
  30.       Specific BBS Installation Examples and Notes
  31.         Generic Installation
  32.           Batch File Example
  33.         Generic Installation
  34.           Command Line Example
  35.         2 A.M.
  36.         Auntie
  37.         DoorWay to Unlimited Doors
  38.         EIS-PC
  39.         Force
  40.         FoReM
  41.         Forum
  42.         GAP
  43.         Genesis
  44.         GT
  45.         Maximus
  46.         ModuleX
  47.         OLEcom
  48.         Opus 1.13
  49.         Opus 1.14
  50.         PCBoard 12.x
  51.         PCBoard 14.x
  52.         Phoenix
  53.         ProBoard
  54.         QuickBBS
  55.         RBBS (batch /R)
  56.         Remote Access
  57.         RyBBS
  58.         Sapphire
  59.         Searchlight
  60.           Command Line Example (/9)
  61.         Simplex
  62.         Spitfire
  63.         TAG
  64.         Telegard
  65.         TPBoard
  66.         Virtual (batch /4, /S, or /Rn)
  67.         WildCat!
  68.         WWIV (batch /4)
  69.  
  70.       Other Notes
  71.         DESQview
  72.         Windows
  73.         OS/2 and other multitaskers
  74.         File Sharing/Locking
  75.  
  76.       What Went Wrong??? (or "Jane, how do I turn this thing off?")
  77.         Error messages
  78.  
  79. BBS Onliner Interface - Command Line Directives
  80.     Be sure to check out the door specific documentation about any
  81.     other command line directives that may be available.
  82.  
  83.     Again Play (/A:x)
  84.         This option will allow players to play multiple games at one
  85.         sitting as long as they have as muchtime.  If they have more
  86.         "x" minutes left (/a:x).  This option carries no recommendation.
  87.  
  88.     Player Name (/N:User_Name)
  89.         This switch is usually only necessary if the user information
  90.         is passed via command line instead of through a drop file (ie:
  91.         Searchlight BBS).  It can also be used for at home play with a
  92.         batch file to make things simple.
  93.  
  94.     Quiet Local Console (/Q)
  95.         This will keep the bell from beeping on the host computer.  This
  96.         lets the SysOp to spleep at night, and it is highly recommended.
  97.  
  98.     Limit Hall Of Fame (/X:n)
  99.         This options the player to a maximum of "n" appearences in the
  100.         Hall of Fame.  I recommend /x:2 as this keeps one or two rabid
  101.         players from monopolizing the Hall of Fame.
  102.  
  103.     Redirect Hall Of Fame (/Y:<path/filespec>
  104.         I heartily recommend using the text Hall of Fames as online
  105.         bulletins.  The BBSs around here that use the bulletins tend
  106.         to have 5 to 10 times the play as the BBSs that don't.  This
  107.         option is fully explained in COMMANDS.BOI.
  108.  
  109.     Maximum Time Limit (/Z:x)
  110.         The BOI normally limits users to the amount of time specified
  111.         in the drop file.  This option allows SysOps to set a maximum
  112.         upper limit.  The game will execute an inactivity time-out at
  113.         approximately two minutes.  It will beep at the halfway point
  114.         and then again when it returns control to the BBS.
  115.  
  116.     Communications Directives (/C /I /K /L F)
  117.         Communications directives are beyond the scope of this
  118.         document.  They are fully explained in COMMANDS.BOI.
  119.  
  120.         Locked Com Ports (/B)
  121.             The BOI (when not using FOSSIL), uses RTS (UART Ready To
  122.             Send) handshaking.  When you lock the DTE-DTC rate (your
  123.             computer to your modem) higher than the possible connect
  124.             rate between your modem and the remote (DTC-DTC rate), RTS
  125.             handshaking is insufficient, and may result in modem buffer
  126.             overruns and loss of data.  Adding this switch implements
  127.             RTS/CTS (Modem Clear To Send) handshaking.
  128.             This switch is strongly RECOMMENDED if you do not use F+.
  129.  
  130.  
  131. BBS Onliner Interface - Specific BBS Installation Examples and Notes
  132.  
  133.     This is where you can help.  I need samples.  Please send me your
  134.     setup.
  135.  
  136.     Generic Installation
  137.         Batch File Example
  138.             Until more examples arrive please check WWIV example.
  139.  
  140.         Command Line Example
  141.             Until more examples arrive please check Searchlight example.
  142.  
  143.     2 A.M. BBS
  144.         The /2 option reads JUMPER.DAT.  Installation example not
  145.         available.
  146.  
  147.     Auntie BBS
  148.         The /7 option reads a file called AUNTIE.SYS.  My information
  149.         on Auntie BBS is extremely limited, and you will also need to
  150.         supply the door with the communications information (/C or /I).
  151.         Installation example not available.
  152.  
  153.     DoorWay to Unlimited Doors
  154.         The /S options reads the "short" DOOR.SYS file.  Installation
  155.         example is not available.
  156.  
  157.     EIS-PC
  158.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  159.         available.
  160.  
  161.     Force
  162.         The /S options reads the "long" DOOR.SYS file.  This is a
  163.         proposed standard format for drop files.  Installation example
  164.         is not available.
  165.  
  166.     FoReM
  167.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  168.         available.
  169.  
  170.     Forum
  171.         The /F option reads USERINFO.TXT.  Installation example not
  172.         available.
  173.  
  174.     GAP
  175.         The /S options reads the "long" DOOR.SYS file.  This is a
  176.         proposed standard format for drop files.  Installation example
  177.         is not available.
  178.  
  179.     Genesis
  180.         The support for Genesis' CALLINFO.BBS is untested.  If you try
  181.         this /G option, please let me know whether or not it works.
  182.  
  183.     GT
  184.         The /S options reads the "short" DOOR.SYS file.  Installation
  185.         example is not available.
  186.  
  187.     Maximus
  188.         The BOI is able to read many of the various drop files that
  189.         Maximus can create.  I would really appreciate it if I could
  190.         get hold of a few installation examples.
  191.  
  192.     ModuleX
  193.         The /M option reads NUMBER.TXT.  Installation example not
  194.         available.
  195.  
  196.     OLEcom
  197.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  198.         available.
  199.  
  200.     Opus-CBCS 1.13
  201.         My documentation on Opus 1.13's drop file(s) is incomplete.  I'd
  202.         appreciate any help.
  203.  
  204.     Opus-CBCS 1.14
  205.         The /Oxx option reads LASTUSxx.DAT (where xx is the Opus task
  206.         number in hexadecimal, if xx is not present the door looks for
  207.         a file called LASTUSER.DAT.).  Example:
  208.  
  209.         doorgame /o0e:c:\opus\
  210.  
  211.         the c:\opus\ tells it to look for LASTUS0E.DAT in the C:\OPUS\
  212.         directory.  Complete installation example is not available.
  213.  
  214.     PCBoard 12.x
  215.         The /1 option reads PCBOARD.SYS.  My documentation on this file
  216.         is incomplete, and I'd appreciate any additional information.
  217.         Installation example not available.
  218.  
  219.     PCBoard 14.x
  220.         The /P option reads PCBOARD.SYS.  As per PCBoard specifications
  221.         the BOI will blank out most of this file if the user drops
  222.         carrier while in the door.  Installation example not available.
  223.  
  224.     Phoenix
  225.         The /H option reads INFO.BBS.  Installation example not
  226.         available.
  227.  
  228.     ProBoard
  229.         I would really appreciate any information about dropfiles that
  230.         ProBoard creates.  Installation examples would also be nice.
  231.  
  232.     QuickBBS
  233.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  234.         available.
  235.  
  236.     RBBS
  237.         The /Rx option reads DORINFOx.DAT.  The follow installation
  238.         example is courtesy of Arnold Robinson.
  239.  
  240.         RBBS directory        -> C:\RBBS
  241.         batch file directory  -> C:\RBBS
  242.         batch file            -> DOORGAME.BAT
  243.         doorgame directory    -> C:\RBBS\DOOR
  244.            (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY)
  245.         bulletins directory   -> C:\RBBS\BULLETIN
  246.  
  247.         RBBS config parm 109  -> DOORS.DEF
  248.  
  249.         Put this line in C:\RBBS\DOORS.DEF
  250.         "DOORGAME",10,,D,"DOORGAME.BAT",N,,30
  251.  
  252.         what the values mean (most are optional), the values ar not
  253.         necessarily recommendation, merely what Arnold uses.
  254.             "DOORGAME"     - name of door
  255.             10             - securitly level
  256.             (blank)        - questionaire to execute
  257.             D              - "D"rop or "S"hell to door
  258.             "DOORGAME.BAT" - batch file to run
  259.             N              - ask for password on return (Y/N)
  260.             (blank)        - file to display on return
  261.             30             - max time allowed in door
  262.  
  263.         C:\RBBS\DOORGAME.BAT listing
  264.             @echo off
  265.             cd c:\rbbs\door
  266.             doorgame /r1c:\rbbs\ /yc:\rbbs\bulletin\ /q /x:2 /a /b
  267.             cd c:\rbbs
  268.  
  269.     Remote Access
  270.         Remote Access can run doors in several different ways (Type 7,
  271.         Type 15, command line).  The BOI should be able to handle all
  272.         of those using either DORINFOx.DAT or DOOR.SYS.  I would
  273.         appreciate any installation examples.  The /Rx option reads
  274.         DORINFOx.DAT.
  275.  
  276.     RyBBS
  277.         The /5 option reads CURRUSER.BBS.  Installation example not
  278.         available.
  279.  
  280.     Sapphire
  281.         My documentation on Sapphire's SAPPHIRE.DAT is incomplete. I
  282.         would appreciate any further information on what dropfiles that
  283.         Sapphire creates.
  284.  
  285.     Searchlight
  286.         I do not have any information regarding any drop files that
  287.         Searchlight creates.
  288.  
  289.         Command Line Example
  290.             The BOI allows BBSes to pass information to it via command
  291.             line.  This bypasses the need for batch files.  By using the
  292.             /9 switch, the BOI knows to get the information it needs
  293.             from the command line.  The /9 tells the BOI where to find
  294.             the door and its associated files.  For example
  295.  
  296.                 c:\slbbs\games\doorgame /9
  297.  
  298.             This command tells the BOI that all extra files (data files,
  299.             hall of fames, etc...) should be kept in c:\slbbs\games\.
  300.             You will also need to tell the BOI the user's name, the
  301.             amount of time the user has left, and the commport.  You
  302.             might try the following:
  303.  
  304.                 c:\slbbs\games\doorgame /9 /n%U /z%M /c:%P (...)
  305.  
  306.             The %U passes the door the users name (Andrew_Mead), the
  307.             %M passes the time remaining in minutes, and the %P tells
  308.             the door what commport is in use.  The elipses (...) just
  309.             represents the other switches you might choose to use.
  310.  
  311.     Simplex
  312.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  313.         available.
  314.  
  315.     Spitfire
  316.         The /6 option reads SFDOORS.DAT.  Installation example is not
  317.         available.
  318.  
  319.     TAG
  320.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  321.         available.
  322.  
  323.     Telegard
  324.         I believe that Telegard creates CHAIN.TXT, and installation is
  325.         probably similiar to that of WWIV.
  326.  
  327.     TPBoard
  328.         The /Rx option reads DORINFOx.DAT.  Installation example is not
  329.         available.
  330.  
  331.     Virtual
  332.         Virtual BBS can create several different drop files.
  333.         Here is an example (courtesy Patrick Murray).  I recommend using
  334.         the /4 (CHAIN.TXT) command, as it shows both user name and
  335.         handle.  You can also use /Rn (DORINFOn.DEF) and /S (long
  336.         DOOR.SYS).
  337.  
  338.         CHAIN.TXT directory   -> C:\VBBS
  339.         batch file directory  -> C:\VBBS\GAMES
  340.         batch file            -> DOOR.BAT
  341.         doorgame directory    -> C:\VBBS\GAMES\DOOR
  342.            (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY)
  343.         bulletins directory   -> C:\VBBS\GAMES\HOF
  344.  
  345.         VConfig / Doors settings
  346.             1. Program Name: DoorGame (ANSI)
  347.             2. Command Line: C:\VBBS\GAMES\DOOR.BAT
  348.  
  349.         C:\WWIV\GAMES\DOOR.BAT listing
  350.             @echo off
  351.             cd c:\vbbs\games\door
  352.             doorgame /4c:\vbbs\ /yc:\vbbs\games\hof\ /q /x:2 /a /b
  353.             cd c:\vbbs
  354.  
  355.     WildCat!
  356.         The /W option reads CALLINFO.BBS.  Installation example is not
  357.         available.
  358.  
  359.     WWIV
  360.         The /4 option reads CHAIN.TXT.  This is the setting that I use
  361.         on my BBS (The Infinite Improbability BBS, @9952 WWIVnet). The
  362.         sample is for DOORGAME.EXE
  363.  
  364.         CHAIN.TXT directory   -> C:\WWIV
  365.         batch file directory  -> C:\WWIV\GAMES
  366.         batch file            -> door.bat
  367.         doorgame directory    -> C:\WWIV\GAMES\DOOR
  368.            (DOORGAME.EXE, DOORGAME.INS, DOORGAME.LNG, DOORGAME.KEY)
  369.         bulletins directory   -> C:\WWIV\GFILES\HOFSDIR
  370.  
  371.         //CHAINEDIT settings
  372.             A. Description  : DoorGame (ANSI)
  373.             B. Filename     : C:\WWIV\GAMES\DOOR.BAT
  374.             E. ANSI         : Required                <--- Optional
  375.             F. DOS Interrupt: NOT Used                <--- You need this
  376.             G. 300 Baud     : NOT Allowed             <--- Recommended
  377.             H. Shrink       : No                      <--- loads faster
  378.  
  379.         C:\WWIV\GAMES\DOOR.BAT listing
  380.             @echo off
  381.             cd c:\wwiv\games\door
  382.             doorgame /4c:\wwiv\ /yc:\wwiv\gfiles\hofsdir\ /q /x:2 /a /b
  383.             cd c:\wwiv
  384.  
  385. BBS Onliner Interface - Other Notes
  386.  
  387.     DESQview
  388.         The BBS Onliner Interface is DESQview aware.  It will give up
  389.         time to other applications while waiting for input.  If the
  390.         internal async routines are active, it will also alert DESQview
  391.         when it is in a critical state.
  392.  
  393.         Some notes are filtering in about QEMM complaining about the
  394.         command line.  One user stated he got the door working by
  395.         removing the extraneous colons from the command line.
  396.  
  397.                    /sc:\bbs\   instead of   /s:c:\bbs\
  398.  
  399.         I do not understand any of this, but it might help you out.  If
  400.         anyone can document any problems with QEMM or DESQview please
  401.         contact me.
  402.  
  403.     Windows, OS/2 and other DOS multitaskers
  404.         The BBS Onliner Interface will give up time slices to all DOS
  405.         based multitaskers that play by DOSes rules.  I have verified
  406.         reports that since this capability was added, Windows sessions
  407.         in other windows are now much, much faster.
  408.  
  409.     File Sharing/Locking
  410.         The BBS Onliner Interface now supports rudimentary file sharing
  411.         and locking.  If the author of the doors has used the built in
  412.         file handling routines, then the door should run well in multi-
  413.         node environments.
  414.  
  415.     What Went Wrong??? (or "Jane, how do I turn this thing off?")
  416.         Program Crashes at end of game.
  417.             You probably have a corrupted Hall of Fame data file.
  418.             Check the door specific documentation as to what files
  419.             might be involved.
  420.  
  421.         Error messages
  422.             Currently defined error messages that you will find in
  423.             BOIERR.LOG, their causes, and possible solutions.
  424.  
  425.             error  explained
  426.                2   Unkown or incorrect argument on command line.
  427.                3   Unsupported file format.  Please send me any and all
  428.                    information you might have on your BBS software's
  429.                    drop file, and I'll add support for it.
  430.                4   Unable to find file.
  431.                5   Error in file.  This means that file does not match
  432.                    the structure that I have for it.  If you are using
  433.                    a DOOR.SYS drop file, try using the other one (/S /D)
  434.                7   Duplicate directives.
  435.                8   Path/Filename for Hall of Fame is not valid.  You
  436.                    have given the /Y switch an invalid path/filespec.
  437.                9   Path not valid.
  438.               11   Invalid or missing number in /X:nn switch.
  439.               12   /X:nn value out of range.  This must be between 1-19.
  440.               13   Invalid or missing value in /C:n.  "n" must be a
  441.                    valid port number.  1 to 4 if you are not using a
  442.                    FOSSIL driver, and 1 to 8 if you are.
  443.               16   /L can not be used with either /C or /I.
  444.               17   Invald format in /I:i:nnnn.  The nnnn must use all
  445.                    four spaces.
  446.               18   Invald hexadecimal in /I:i:nnnn.
  447.               19   Invalid numeric in /A:x.
  448.               20   /A:x time value must be at least 5 minutes.
  449.               31   Unable to find/initialize FOSSIL driver.  Please
  450.                    notify me, and check your setup.  This switch should
  451.                    only occur if you use the F+ switch.
  452.  
  453.  
  454. BBS Onliner Interface
  455. Copyright (C) 1990, 1992 Andrew J. Mead
  456. All Rights Reserved.
  457.  
  458. Contact:
  459.     Andrew J. Mead
  460.     PO BOX 1155
  461.     Chapel Hill, NC 27514-1155
  462.     USA
  463.  
  464.     1@9952 WWIVnet
  465.     1@9395 VirtualNet
  466.     1:3641/417 FidoNet
  467.     75:7919/417 DoorNet
  468.  
  469.     +919 489 9446 - PCP:NCRTP - V32BIS - 24HRS
  470.  
  471. END INSTALL.BOI